home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 33 / Amiga Format AFCD33 (Issue 117, Dec 1998).iso / -seriously_amiga- / sound / mpeginoutppc / common.h < prev    next >
C/C++ Source or Header  |  1998-09-07  |  17KB  |  470 lines
  1. /**********************************************************************
  2. Copyright (c) 1991 MPEG/audio software simulation group, All Rights Reserved
  3. common.h
  4. **********************************************************************/
  5. /**********************************************************************
  6.  * MPEG/audio coding/decoding software, work in progress              *
  7.  *   NOT for public distribution until verified and approved by the   *
  8.  *   MPEG/audio committee.  For further information, please contact   *
  9.  *   Davis Pan, 508-493-2241, e-mail: pan@gauss.enet.dec.com          *
  10.  *                                                                    *
  11.  * VERSION 4.0                                                        *
  12.  *   changes made since last update:                                  *
  13.  *   date   programmers         comment                               *
  14.  * 2/25/91  Doulas Wong,        start of version 1.0 records          *
  15.  *          Davis Pan                                                 *
  16.  * 5/10/91  W. Joseph Carter    Reorganized & renamed all ".h" files  *
  17.  *                              into "common.h" and "encoder.h".      *
  18.  *                              Ported to Macintosh and Unix.         *
  19.  *                              Added additional type definitions for *
  20.  *                              AIFF, double/SANE and "bitstream.c".  *
  21.  *                              Added function prototypes for more    *
  22.  *                              rigorous type checking.               *
  23.  * 27jun91  dpwe (Aware)        Added "alloc_*" defs & prototypes     *
  24.  *                              Defined new struct 'frame_params'.    *
  25.  *                              Changed info.stereo to info.mode_ext  *
  26.  *                              #define constants for mode types      *
  27.  *                              Prototype arguments if PROTO_ARGS     *
  28.  * 5/28/91  Earle Jennings      added MS_DOS definition               *
  29.  *                              MsDos function prototype declarations *
  30.  * 7/10/91  Earle Jennings      added FLOAT definition as double      *
  31.  *10/ 3/91  Don H. Lee          implemented CRC-16 error protection   *
  32.  * 2/11/92  W. Joseph Carter    Ported new code to Macintosh.  Most   *
  33.  *                              important fixes involved changing     *
  34.  *                              16-bit ints to long or unsigned in    *
  35.  *                              bit alloc routines for quant of 65535 *
  36.  *                              and passing proper function args.     *
  37.  *                              Removed "Other Joint Stereo" option   *
  38.  *                              and made bitrate be total channel     *
  39.  *                              bitrate, irrespective of the mode.    *
  40.  *                              Fixed many small bugs & reorganized.  *
  41.  *                              Modified some function prototypes.    *
  42.  *                              Changed BUFFER_SIZE back to 4096.     *
  43.  * 7/27/92  Michael Li          (re-)Ported to MS-DOS                 *
  44.  * 7/27/92  Masahiro Iwadare    Ported to Convex                      *
  45.  * 8/07/92  mc@tv.tek.com                                             *
  46.  * 8/10/92  Amit Gulati         Ported to the AIX Platform (RS6000)   *
  47.  *                              AIFF string constants redefined       *
  48.  * 8/27/93 Seymour Shlien,      Fixes in Unix and MSDOS ports,        *
  49.  *         Daniel Lauzon, and                                         *
  50.  *         Bill Truerniet                                             *
  51.  **********************************************************************/
  52.  
  53. /***********************************************************************
  54. *
  55. *  Global Conditional Compile Switches
  56. *
  57. ***********************************************************************/
  58.  
  59. #define      UNIX            /* Unix conditional compile switch */
  60. /* #define      MACINTOSH       /* Macintosh conditional compile switch */
  61. /* #define      MS_DOS          /* IBM PC conditional compile switch */
  62. /* #define      MSC60           /* Compiled for MS_DOS with MSC v6.0 */
  63. #define      AIX             /* AIX conditional compile switch    */
  64. /* #define      CONVEX          /* CONVEX conditional compile switch */
  65.  
  66. #if defined(MSC60) 
  67. #ifndef MS_DOS
  68. #define MS_DOS
  69. #endif
  70. #ifndef PROTO_ARGS
  71. #define PROTO_ARGS
  72. #endif
  73. #endif
  74.  
  75. #ifdef  UNIX
  76. #define         TABLES_PATH     "tables"  /* to find data files */
  77. /* name of environment variable holding path of table files */
  78. #define         MPEGTABENV      "MPEGTABLES"
  79. #define         PATH_SEPARATOR  "/"        /* how to build paths */
  80. #endif  /* UNIX */
  81.  
  82. #ifdef  MACINTOSH
  83. /* #define      TABLES_PATH ":tables:"  /* where to find data files */
  84. #endif  /* MACINTOSH */
  85.  
  86. /* 
  87.  * Don't define FAR to far unless you're willing to clean up the 
  88.  * prototypes
  89.  */
  90. #define FAR /*far*/
  91.  
  92. #ifdef __STDC__
  93. #ifndef PROTO_ARGS
  94. #define PROTO_ARGS
  95. #endif
  96. #endif
  97.  
  98. #ifdef CONVEX
  99. #define SEEK_SET        0
  100. #define SEEK_CUR        1
  101. #define SEEK_END        2
  102. #endif
  103.  
  104. /* MS_DOS and VMS do not define TABLES_PATH, so OpenTableFile will default
  105.    to finding the data files in the default directory */
  106.  
  107. /***********************************************************************
  108. *
  109. *  Global Include Files
  110. *
  111. ***********************************************************************/
  112.  
  113. #include        <stdio.h>
  114. #include        <string.h>
  115. #include        <math.h>
  116.  
  117. #ifdef  UNIX
  118. #include        <unistd.h>
  119. #endif  /* UNIX */
  120.  
  121. #ifdef  MACINTOSH
  122. #include        <stdlib.h>
  123. #include        <console.h>
  124. #endif  /* MACINTOSH */
  125.  
  126. #ifdef  MS_DOS
  127. #include        <stdlib.h>
  128. #ifdef MSC60
  129. #include        <memory.h>
  130. #else
  131. #include        <alloc.h>
  132. #include        <mem.h>
  133. #endif  /* MSC60 */
  134. #endif  /* MS_DOS */
  135.  
  136. /***********************************************************************
  137. *
  138. *  Global Definitions
  139. *
  140. ***********************************************************************/
  141.  
  142. /* General Definitions */
  143.  
  144. #ifdef  MS_DOS
  145. #define         FLOAT                   double
  146. #else
  147. #define         FLOAT                   float
  148. #endif
  149.  
  150. #define         FALSE                   0
  151. #define         TRUE                    1
  152. #define         NULL_CHAR               '\0'
  153.  
  154. #define         MAX_U_32_NUM            0xFFFFFFFF
  155. #define         PI                      3.14159265358979
  156. #define         PI4                     PI/4
  157. #define         PI64                    PI/64
  158. #define         LN_TO_LOG10             0.2302585093
  159.  
  160. #define         VOL_REF_NUM             0
  161. #define         MPEG_AUDIO_ID           1
  162. #define         MAC_WINDOW_SIZE         24
  163.  
  164. #define         MONO                    1
  165. #define         STEREO                  2
  166. #define         BITS_IN_A_BYTE          8
  167. #define         WORD                    16
  168. #define         MAX_NAME_SIZE           81
  169. #define         SBLIMIT                 32
  170. #define         FFT_SIZE                1024
  171. #define         HAN_SIZE                512
  172. #define         SCALE_BLOCK             12
  173. #define         SCALE_RANGE             64
  174. #define         SCALE                   32768
  175. #define         CRC16_POLYNOMIAL        0x8005
  176.  
  177. /* MPEG Header Definitions - Mode Values */
  178.  
  179. #define         MPG_MD_STEREO           0
  180. #define         MPG_MD_JOINT_STEREO     1
  181. #define         MPG_MD_DUAL_CHANNEL     2
  182. #define         MPG_MD_MONO             3
  183.  
  184. /* AIFF Definitions */
  185.  
  186. /* 
  187.  * Note:  The value of a multi-character constant
  188.  *        is implementation-defined.
  189.  */
  190. #if !defined(MS_DOS) && !defined(AIX)  
  191. #define         IFF_LONG
  192. #define         IFF_ID_FORM             'FORM'
  193. #define         IFF_ID_AIFF             'AIFF'
  194. #define         IFF_ID_COMM             'COMM'
  195. #define         IFF_ID_SSND             'SSND'
  196. #define         IFF_ID_MPEG             'MPEG'
  197. #else
  198. #define         IFF_ID_FORM             "FORM"
  199. #define         IFF_ID_AIFF             "AIFF"
  200. #define         IFF_ID_COMM             "COMM"
  201. #define         IFF_ID_SSND             "SSND"
  202. #define         IFF_ID_MPEG             "MPEG"
  203. #endif
  204.  
  205. /* "bit_stream.h" Definitions */
  206.  
  207. #define         MINIMUM         4    /* Minimum size of the buffer in bytes */
  208. #define         MAX_LENGTH      32   /* Maximum length of word written or
  209.                                         read from bit stream */
  210. #define         READ_MODE       0
  211. #define         WRITE_MODE      1
  212. #define         ALIGNING        8
  213. #define         BINARY          0
  214. #define         ASCII           1
  215. #define         BS_FORMAT       BINARY /* BINARY or ASCII = 2x bytes */
  216. #define         BUFFER_SIZE     4096
  217.  
  218. #define         MIN(A, B)       ((A) < (B) ? (A) : (B))
  219. #define         MAX(A, B)       ((A) > (B) ? (A) : (B))
  220.  
  221. /***********************************************************************
  222. *
  223. *  Global Type Definitions
  224. *
  225. ***********************************************************************/
  226.  
  227. /* Structure for Reading Layer II Allocation Tables from File */
  228.  
  229. typedef struct {
  230.     unsigned int    steps;
  231.     unsigned int    bits;
  232.     unsigned int    group;
  233.     unsigned int    quant;
  234. } sb_alloc, *alloc_ptr;
  235.  
  236. typedef sb_alloc        al_table[SBLIMIT][16];
  237.  
  238. /* Header Information Structure */
  239.  
  240. typedef struct {
  241.     int version;
  242.     int lay;
  243.     int error_protection;
  244.     int bitrate_index;
  245.     int sampling_frequency;
  246.     int padding;
  247.     int extension;
  248.     int mode;
  249.     int mode_ext;
  250.     int copyright;
  251.     int original;
  252.     int emphasis;
  253. } layer, *the_layer;
  254.  
  255. /* Parent Structure Interpreting some Frame Parameters in Header */
  256.  
  257. typedef struct {
  258.     layer       *header;        /* raw header information */
  259.     int         actual_mode;    /* when writing IS, may forget if 0 chs */
  260.     al_table    *alloc;         /* bit allocation table read in */
  261.     int         tab_num;        /* number of table as loaded */
  262.     int         stereo;         /* 1 for mono, 2 for stereo */
  263.     int         jsbound;        /* first band of joint stereo coding */
  264.     int         sblimit;        /* total number of sub bands */
  265. } frame_params;
  266.  
  267. /* Double and SANE Floating Point Type Definitions */
  268.  
  269. typedef struct  IEEE_DBL_struct {
  270.     unsigned long   hi;
  271.     unsigned long   lo;
  272. } IEEE_DBL;
  273.  
  274. typedef struct  SANE_EXT_struct {
  275.     unsigned long   l1;
  276.     unsigned long   l2;
  277.     unsigned short  s1;
  278. } SANE_EXT;
  279.  
  280. /* AIFF Type Definitions */
  281.  
  282. typedef char    ID[4];
  283.  
  284. typedef struct  ChunkHeader_struct {
  285.     ID      ckID;
  286.     long    ckSize;
  287. } ChunkHeader;
  288.  
  289. typedef struct  Chunk_struct {
  290.     ID      ckID;
  291.     long    ckSize;
  292.     ID      formType;
  293. } Chunk;
  294.  
  295. typedef struct  CommonChunk_struct {
  296.     ID              ckID;
  297.     long            ckSize;
  298.     short           numChannels;
  299.     unsigned long   numSampleFrames;
  300.     short           sampleSize;
  301.     char            sampleRate[10];
  302. } CommonChunk;
  303.  
  304. typedef struct  SoundDataChunk_struct {
  305.     ID              ckID;
  306.     long            ckSize;
  307.     unsigned long   offset;
  308.     unsigned long   blockSize;
  309. } SoundDataChunk;
  310.  
  311. typedef struct  blockAlign_struct {
  312.     unsigned long   offset;
  313.     unsigned long   blockSize;
  314. } blockAlign;
  315.  
  316. typedef struct  IFF_AIFF_struct {
  317.     short           numChannels;
  318.     unsigned long   numSampleFrames;
  319.     short           sampleSize;
  320.     double          sampleRate;
  321.     unsigned long   sampleType;
  322.     blockAlign      blkAlgn;
  323. } IFF_AIFF;
  324.  
  325. /* "bit_stream.h" Type Definitions */
  326.  
  327. typedef struct  bit_stream_struc {
  328.     FILE        *pt;            /* pointer to bit stream device */
  329.     unsigned char *buf;         /* bit stream buffer */
  330.     int         buf_size;       /* size of buffer (in number of bytes) */
  331.     long        totbit;         /* bit counter of bit stream */
  332.     int         buf_byte_idx;   /* pointer to top byte in buffer */
  333.     int         buf_bit_idx;    /* pointer to top bit of top byte in buffer */
  334.     int         mode;           /* bit stream open in read or write mode */
  335.     int         eob;            /* end of buffer index */
  336.     int         eobs;           /* end of bit stream flag */
  337.     char        format;
  338.     
  339.     /* format of file in rd mode (BINARY/ASCII) */
  340. } Bit_stream_struc;
  341.  
  342. /***********************************************************************
  343. *
  344. *  Global Variable External Declarations
  345. *
  346. ***********************************************************************/
  347.  
  348. extern char     *mode_names[4];
  349. extern char     *layer_names[3];
  350. extern double   s_freq[4];
  351. extern int      bitrate[3][15];
  352. extern double FAR multiple[64];
  353.  
  354. /***********************************************************************
  355. *
  356. *  Global Function Prototype Declarations
  357. *
  358. ***********************************************************************/
  359.  
  360. /* The following functions are in the file "common.c" */
  361.  
  362. #ifdef  PROTO_ARGS
  363. extern FILE           *OpenTableFile(char*);
  364. extern int            read_bit_alloc(int, al_table*);
  365. extern int            pick_table(frame_params*);
  366. extern int            js_bound(int, int);
  367. extern void           hdr_to_frps(frame_params*);
  368. extern void           WriteHdr(frame_params*, FILE*);
  369. extern void           WriteBitAlloc(unsigned int[2][SBLIMIT], frame_params*,
  370.                         FILE*);
  371. extern void           WriteScale(unsigned int[2][SBLIMIT],
  372.                         unsigned int[2][SBLIMIT], unsigned int[2][3][SBLIMIT],
  373.                         frame_params*, FILE*);
  374. extern void           WriteSamples(int, unsigned int FAR [SBLIMIT],
  375.                         unsigned int[SBLIMIT], frame_params*, FILE*);
  376. extern int            NumericQ(char*);
  377. extern int            BitrateIndex(int, int);
  378. extern int            SmpFrqIndex(long);
  379. extern int            memcheck(char*, int, int);
  380. extern void           FAR *mem_alloc(unsigned long, char*);
  381. extern void           mem_free(void**);
  382. extern void           double_to_extended(double*, char[10]);
  383. extern void           extended_to_double(char[10], double*);
  384. extern int            aiff_read_headers(FILE*, IFF_AIFF*);
  385. extern int            aiff_seek_to_sound_data(FILE*);
  386. extern int            aiff_write_headers(FILE*, IFF_AIFF*);
  387. extern int            refill_buffer(Bit_stream_struc*);
  388. extern void           empty_buffer(Bit_stream_struc*, int);
  389. extern void           open_bit_stream_w(Bit_stream_struc*, char*, int);
  390. extern void           open_bit_stream_r(Bit_stream_struc*, char*, int);
  391. extern void           close_bit_stream_r(Bit_stream_struc*);
  392. extern void           close_bit_stream_w(Bit_stream_struc*);
  393. extern void           alloc_buffer(Bit_stream_struc*, int);
  394. extern void           desalloc_buffer(Bit_stream_struc*);
  395. extern void           back_track_buffer(Bit_stream_struc*, int);
  396. extern unsigned int   get1bit(Bit_stream_struc*);
  397. extern void           put1bit(Bit_stream_struc*, int);
  398. extern unsigned long  look_ahead(Bit_stream_struc*, int);
  399. extern unsigned long  getbits(Bit_stream_struc*, int);
  400. extern void           putbits(Bit_stream_struc*, unsigned int, int);
  401. extern void           byte_ali_putbits(Bit_stream_struc*, unsigned int, int);
  402. extern unsigned long  byte_ali_getbits(Bit_stream_struc*, int);
  403. extern unsigned long  sstell(Bit_stream_struc*);
  404. extern int            end_bs(Bit_stream_struc*);
  405. extern int            seek_sync(Bit_stream_struc*, long, int);
  406. extern void           I_CRC_calc(frame_params*, unsigned int[2][SBLIMIT],
  407.                         unsigned int*);
  408. extern void           II_CRC_calc(frame_params*, unsigned int[2][SBLIMIT],
  409.                         unsigned int[2][SBLIMIT], unsigned int*);
  410. extern void           update_CRC(unsigned int, unsigned int, unsigned int*);
  411. extern void           read_absthr(FLOAT*, int);
  412.  
  413. #ifdef  MACINTOSH
  414. extern void           set_mac_file_attr(char[MAX_NAME_SIZE], short, OsType,
  415.                         OsType);
  416. #endif
  417. #ifdef MS_DOS
  418. extern char           *new_ext(char *filename, char *extname); 
  419. #endif
  420.  
  421. #else
  422. extern FILE           *OpenTableFile();
  423. extern int            read_bit_alloc();
  424. extern int            pick_table();
  425. extern int            js_bound();
  426. extern void           hdr_to_frps();
  427. extern void           WriteHdr();
  428. extern void           WriteBitAlloc();
  429. extern void           WriteScale();
  430. extern void           WriteSamples();
  431. extern int            NumericQ();
  432. extern int            BitrateIndex();
  433. extern int            SmpFrqIndex();
  434. extern int            memcheck();
  435. extern void           FAR *mem_alloc();
  436. extern void           mem_free();
  437. extern void           double_to_extended();
  438. extern void           extended_to_double();
  439. extern int            aiff_read_headers();
  440. extern int            aiff_seek_to_sound_data();
  441. extern int            aiff_write_headers();
  442. extern int            refill_buffer();
  443. extern void           empty_buffer();
  444. extern void           open_bit_stream_w();
  445. extern void           open_bit_stream_r();
  446. extern void           close_bit_stream_r();
  447. extern void           close_bit_stream_w();
  448. extern void           alloc_buffer();
  449. extern void           desalloc_buffer();
  450. extern void           back_track_buffer();
  451. extern unsigned int   get1bit();
  452. extern void           put1bit();
  453. extern unsigned long  look_ahead();
  454. extern unsigned long  getbits();
  455. extern void           putbits();
  456. extern void           byte_ali_putbits();
  457. extern unsigned long  byte_ali_getbits();
  458. extern unsigned long  sstell();
  459. extern int            end_bs();
  460. extern int            seek_sync();
  461. extern void           I_CRC_calc();
  462. extern void           II_CRC_calc();
  463. extern void           update_CRC();
  464. extern void           read_absthr();
  465.  
  466. #ifdef MS_DOS
  467. extern char           *new_ext(); 
  468. #endif
  469. #endif
  470.